Portal Android SDK/io.portalhq.android.api.data.lifi

Package-level declarations

Types

data class LifiAction(val fromChainId: String, val fromAmount: String, val fromToken: LifiToken, val toChainId: String, val toToken: LifiToken, val slippage: Double? = null, val fromAddress: String? = null, val toAddress: String? = null, val destinationGasConsumption: String? = null)

Action within a step

LifiBid

data class LifiBid(val user: String? = null, val router: String? = null, val initiator: String? = null, val sendingChainId: String? = null, val sendingAssetId: String? = null, val amount: String? = null, val receivingChainId: String? = null, val receivingAssetId: String? = null, val amountReceived: String? = null, val receivingAddress: String? = null, val transactionId: String? = null, val expiry: Int? = null, val callDataHash: String? = null, val callTo: String? = null, val encryptedCallData: String? = null, val sendingChainTxManagerAddress: String? = null, val receivingChainTxManagerAddress: String? = null, val bidExpiry: Int? = null)

Bid information

LifiErrorCode

enum LifiErrorCode : Enum<LifiErrorCode>

Error code

LifiErrorType

enum LifiErrorType : Enum<LifiErrorType>

Error type

LifiEstimate

data class LifiEstimate(val tool: String, val fromAmount: String, val toAmount: String, val toAmountMin: String, val approvalAddress: String, val executionDuration: Double, val fromAmountUSD: String? = null, val toAmountUSD: String? = null, val feeCosts: List<LifiFeeCost>? = null, val gasCosts: List<LifiGasCost>? = null, val data: LifiEstimateData? = null)

Estimate for a step

LifiEstimateData

data class LifiEstimateData(val bid: LifiBid? = null, val bidSignature: String? = null, val gasFeeInReceivingToken: String? = null, val totalFee: String? = null, val metaTxRelayerFee: String? = null, val routerFee: String? = null)

Estimate data (arbitrary data that depends on the tool)

LifiFailedRoute

data class LifiFailedRoute(val overallPath: String? = null, val subpaths: Map<String, LifiSubpathError>? = null)

Failed route

LifiFeeCost

data class LifiFeeCost(val name: String, val percentage: String, val token: LifiToken, val amountUSD: String, val included: Boolean, val description: String? = null, val amount: String? = null, val feeSplit: LifiFeeSplit? = null)

Fee cost information

LifiFeeSplit

data class LifiFeeSplit(val integratorFee: String? = null, val lifiFee: String? = null)

Fee split between integrator and LI.FI

LifiFilteredRoute

data class LifiFilteredRoute(val overallPath: String? = null, val reason: String? = null)

Filtered out route

LifiGasCost

data class LifiGasCost(val type: LifiGasCostType, val amount: String, val token: LifiToken, val price: String? = null, val estimate: String? = null, val limit: String? = null, val amountUSD: String? = null)

Gas cost information

LifiGasCostType

enum LifiGasCostType : Enum<LifiGasCostType>

Type of gas cost

LifiIncludedSwapStep

data class LifiIncludedSwapStep(val tool: String? = null, val toolDetails: LifiToolDetails? = null, val fromAmount: String? = null, val fromToken: LifiToken? = null, val toAmount: String? = null, val toToken: LifiToken? = null, val bridgedAmount: String? = null)

Included swap or protocol step in the status response

LifiInternalStep

data class LifiInternalStep(val id: String, val type: LifiStepType, val tool: String, val toolDetails: LifiToolDetails, val action: LifiAction, val estimate: LifiEstimate)

Internal step (used in includedSteps)

LifiMetadata

data class LifiMetadata(val integrator: String? = null)

Transaction metadata

LifiPollStatusOptions

data class LifiPollStatusOptions(val everyMs: Long, val initialDelayMs: Long = 0, val timeoutMs: Long, val maxConsecutiveErrors: Int = 5)

Options controlling the LiFi status polling behavior.

LifiProgressHandler

typealias LifiProgressHandler = (status: LifiTradeAssetProgressStatus, data: LifiTradeAssetProgressData) -> Unit

Callback invoked with progress updates while tradeAsset executes.

LifiQuoteData

data class LifiQuoteData(val rawResponse: LifiStep)

LifiQuoteErrorResponse

data class LifiQuoteErrorResponse(val message: String, val errors: LifiUnavailableRoutes? = null)

Error response when unable to find a quote for the requested transfer (404)

LifiQuoteOrder

enum LifiQuoteOrder : Enum<LifiQuoteOrder>

The way the resulting quote should be ordered

LifiQuoteRequest

data class LifiQuoteRequest(val fromChain: String, val toChain: String, val fromToken: String, val toToken: String, val fromAddress: String, val fromAmount: String, val toAddress: String? = null, val order: LifiQuoteOrder? = null, val slippage: Double? = null, val integrator: String? = null, val fee: Double? = null, val referrer: String? = null, val allowBridges: List<String>? = null, val allowExchanges: List<String>? = null, val denyBridges: List<String>? = null, val denyExchanges: List<String>? = null, val preferBridges: List<String>? = null, val preferExchanges: List<String>? = null, val allowDestinationCall: Boolean? = null, val fromAmountForGas: String? = null, val maxPriceImpact: Double? = null, val swapStepTimingStrategies: List<String>? = null, val routeTimingStrategies: List<String>? = null, val skipSimulation: Boolean? = null)

Used to request a quote for a transfer of one token to another, cross chain or not

LifiQuoteResponse

data class LifiQuoteResponse(val data: LifiQuoteData? = null, val error: String? = null)

Response containing a quote from the Lifi integration

LifiReceivingInfo

data class LifiReceivingInfo(val chainId: String? = null, val txHash: String? = null, val txLink: String? = null, val token: LifiToken? = null, val amount: String? = null, val gasToken: LifiToken? = null, val gasAmount: String? = null, val gasAmountUSD: String? = null, val gasPrice: String? = null, val gasUsed: String? = null, val timestamp: Int? = null, val value: String? = null, val includedSteps: List<LifiIncludedSwapStep>? = null)

Receiving chain information (can be partial or full transaction info)

LifiRoute

data class LifiRoute(val id: String, val fromChainId: String, val fromAmountUSD: String, val fromAmount: String, val fromToken: LifiToken, val toChainId: String, val toAmountUSD: String, val toAmount: String, val toAmountMin: String, val toToken: LifiToken, val steps: List<LifiStep>, val gasCostUSD: String? = null, val fromAddress: String? = null, val toAddress: String? = null, val containsSwitchChain: Boolean? = null, val tags: List<String>? = null)

A route that can be used to realize a token transfer

LifiRoutesData

data class LifiRoutesData(val rawResponse: LifiRoutesRawResponse)

LifiRoutesOrder

enum LifiRoutesOrder : Enum<LifiRoutesOrder>

The way the resulting routes should be ordered

LifiRoutesRawResponse

data class LifiRoutesRawResponse(val routes: List<LifiRoute>, val unavailableRoutes: LifiUnavailableRoutes? = null)

LifiRoutesRequest

data class LifiRoutesRequest(val fromChainId: String, val fromAmount: String, val fromTokenAddress: String, val toChainId: String, val toTokenAddress: String, val options: LifiRoutesRequestOptions? = null, val fromAddress: String? = null, val toAddress: String? = null, val fromAmountForGas: String? = null)

Describes a desired any-to-any transfer and contains all information necessary to calculate the most efficient routes

LifiRoutesRequestOptions

data class LifiRoutesRequestOptions(val insurance: Boolean? = null, val integrator: String? = null, val slippage: Double? = null, val bridges: LifiToolsConfiguration? = null, val exchanges: LifiToolsConfiguration? = null, val order: LifiRoutesOrder? = null, val allowSwitchChain: Boolean? = null, val allowDestinationCall: Boolean? = null, val referrer: String? = null, val fee: Double? = null, val maxPriceImpact: Double? = null, val timing: LifiTimingOptions? = null)

Optional configuration for the routes

LifiRoutesResponse

data class LifiRoutesResponse(val data: LifiRoutesData? = null, val error: String? = null)

Response containing routes from the Lifi integration

LifiSignAndSendTransaction

typealias LifiSignAndSendTransaction = suspend (transaction: EthTransactionParam, chainId: String) -> String

Signs and submits an EVM transaction, returning the transaction hash.

LifiStatusBridge

enum LifiStatusBridge : Enum<LifiStatusBridge>

Bridging tools supported for status check

LifiStatusData

data class LifiStatusData(val rawResponse: LifiStatusRawResponse)

LifiStatusRawResponse

data class LifiStatusRawResponse(val sending: LifiTransactionInfo, val receiving: LifiReceivingInfo? = null, val feeCosts: List<LifiFeeCost>? = null, val status: LifiTransferStatus, val substatus: LifiTransferSubstatus? = null, val substatusMessage: String? = null, val tool: String, val transactionId: String? = null, val fromAddress: String? = null, val toAddress: String? = null, val lifiExplorerLink: String? = null, val bridgeExplorerLink: String? = null, val metadata: LifiMetadata? = null)

Contains the current status of a cross chain transfer

LifiStatusRequest

data class LifiStatusRequest(val txHash: String, val bridge: LifiStatusBridge? = null, val fromChain: String? = null, val toChain: String? = null)

Used to check the status of a cross chain transfer

LifiStatusResponse

data class LifiStatusResponse(val data: LifiStatusData? = null, val error: String? = null)

Response containing the status of a cross chain transfer from the Lifi integration

LifiStep

data class LifiStep(val id: String, val type: LifiStepType, val tool: String, val action: LifiAction, val toolDetails: LifiToolDetails? = null, val estimate: LifiEstimate? = null, val includedSteps: List<LifiInternalStep>? = null, val integrator: String? = null, val referrer: String? = null, val execution: JsonElement? = null, val transactionRequest: JsonElement? = null, val transactionId: String? = null, val gasCostUSD: String? = null, val fromAddress: String? = null, val toAddress: String? = null, val containsSwitchChain: Boolean? = null)

Step in a route

LifiStepTransactionData

data class LifiStepTransactionData(val rawResponse: LifiStep)

LifiStepTransactionRequest

typealias LifiStepTransactionRequest = LifiStep

Request for step transaction - type alias for LifiStep

LifiStepTransactionResponse

data class LifiStepTransactionResponse(val data: LifiStepTransactionData? = null, val error: String? = null)

Response containing a step with transaction data from the Lifi integration

LifiStepType

enum LifiStepType : Enum<LifiStepType>

Type of step in a route

LifiSubpathError

data class LifiSubpathError(val errorType: LifiErrorType? = null, val code: LifiErrorCode? = null, val action: LifiAction? = null, val tool: String? = null, val message: String? = null)

Subpath error information

LifiTimingOptions

data class LifiTimingOptions(val swapStepTimingStrategies: List<LifiTimingStrategy>? = null, val routeTimingStrategies: List<LifiTimingStrategy>? = null)

Timing options for routes and swap steps

LifiTimingStrategy

data class LifiTimingStrategy(val strategy: LifiTimingStrategyType? = null, val minWaitTimeMs: Int? = null, val startingExpectedResults: Int? = null, val reduceEveryMs: Int? = null)

Timing strategy configuration

LifiTimingStrategyType

enum LifiTimingStrategyType : Enum<LifiTimingStrategyType>

Type of timing strategy

LifiToken

data class LifiToken(val address: String, val symbol: String, val decimals: Int, val chainId: String, val name: String, val coinKey: String? = null, val logoURI: String? = null, val priceUSD: String? = null)

Token information

LifiToolDetails

data class LifiToolDetails(val key: String? = null, val name: String? = null, val logoURI: String? = null, val webUrl: String? = null)

Tool details

LifiToolsConfiguration

data class LifiToolsConfiguration(val allow: List<String>? = null, val deny: List<String>? = null, val prefer: List<String>? = null)

Configuration for bridges or exchanges (allow, deny, prefer)

LifiTradeAssetException

sealed class LifiTradeAssetException : Exception

Errors that can be thrown by the high-level tradeAsset / pollStatus methods.

LifiTradeAssetParams

data class LifiTradeAssetParams(val fromChain: String, val toChain: String, val fromToken: String, val toToken: String, val amount: String, val fromAddress: String? = null, val toAddress: String? = null, val routeIndex: Int? = null, val onProgress: LifiProgressHandler? = null)

Parameters for the high-level tradeAsset bridging method.

LifiTradeAssetProgressData

data class LifiTradeAssetProgressData(val routeIndex: Int? = null, val stepIndex: Int? = null, val totalSteps: Int? = null, val route: LifiRoute? = null, val step: LifiStep? = null, val txHash: String? = null, val lifiStatus: LifiStatusRawResponse? = null, val errorMessage: String? = null)

Contextual data passed alongside a progress status.

LifiTradeAssetProgressStatus

enum LifiTradeAssetProgressStatus : Enum<LifiTradeAssetProgressStatus>

Progress status values emitted by tradeAsset via the onProgress callback.

LifiTradeAssetResult

data class LifiTradeAssetResult(val hashes: List<String>, val steps: List<LifiStep>, val route: LifiRoute)

The result of a successful tradeAsset execution.

LifiTransactionInfo

data class LifiTransactionInfo(val txHash: String, val txLink: String, val amount: String, val amountUSD: String? = null, val token: LifiToken, val chainId: String, val gasToken: LifiToken? = null, val gasAmount: String? = null, val gasAmountUSD: String? = null, val gasPrice: String? = null, val gasUsed: String? = null, val timestamp: Int? = null, val value: String? = null, val includedSteps: List<LifiIncludedSwapStep>? = null)

Transaction information

LifiTransferStatus

enum LifiTransferStatus : Enum<LifiTransferStatus>

The current status of the transfer

LifiTransferSubstatus

enum LifiTransferSubstatus : Enum<LifiTransferSubstatus>

A more specific substatus for PENDING and DONE statuses

LifiUnavailableRoutes

data class LifiUnavailableRoutes(val filteredOut: List<LifiFilteredRoute>? = null, val failed: List<LifiFailedRoute>? = null)

Unavailable routes information

LifiWaitForConfirmation

typealias LifiWaitForConfirmation = suspend (txHash: String, chainId: String) -> Boolean

Waits for an on-chain transaction confirmation. Returns true on success.